Skip to content

0.3.3.post1: fix GitHub MathJax rendering across docs - #59

Merged
FonaTech merged 1 commit into
mainfrom
release-0.3.3
Nov 13, 2026
Merged

FonaTech merged 1 commit into
mainfrom
release-0.3.3

Conversation

@FonaTech

Copy link
Copy Markdown
Owner

Docs-only post-release. No kernel, trainer, planner, auto-tune, Web UI, serving or wheel-content changes relative to 0.3.3.

Problem

GitHub's MathJax configuration disallows `\operatorname`, and a bare `h^*` superscript inside an `aligned` block in `docs/KERNEL_ARCHITECTURE.md` cascaded into equations K.4-K.9 showing as raw text on github.com. Visible symptoms the user hit:

  • 'The following macros are not allowed: operatorname' errors on K.4 and K.9.
  • 'Missing open brace for superscript' on K.5 (the bare `h^*` inside an `aligned` block).
  • K.6 rendered as literal text because the earlier parse failures cascaded through the file.

Fix

  • Replace `\operatorname{X}` with `\mathrm{X}` in `docs/` (9 files).
  • Replace `\operatorname*{X}_y` with `\mathop{\mathrm{X}}\limits_y` to preserve the under-operator limit position.
  • Replace bare `h^*` with `h^{\ast}`.
  • Matplotlib-mathtext strings in `docs/assets/arch/make_arch.py` and the generated SVG XML comments are unaffected (different renderer).

Audit

Repo-wide scans after the fix: zero `\operatorname` in docs, zero disallowed macros, zero CJK-adjacent dollar boundaries, zero unsupported math environments, every `\tag` inside its `$$` fences, every `$$` fence paired.

🤖 Generated with Claude Code

GitHub's MathJax configuration disallows \operatorname, leaves \!
(negative thin space) as a literal '!', and trips on a bare 'h^*'
superscript inside an aligned block. Together these cascaded into
equations K.4-K.9 of docs/KERNEL_ARCHITECTURE.md showing as raw text
and eq (3) of docs/LAZY_EXPERTS.md losing its multiplication sign.

Fixes (docs/, 10 files):
- \operatorname{X} -> \mathrm{X}; \operatorname*{X}_y ->
  \mathop{\mathrm{X}}\limits_y (preserves limit position).
- Bare h^* -> h^{\ast}.
- Drop \! everywhere in math (ATTENTION, CLUSTER_LOCALITY,
  LAZY_EXPERTS, LONG_CONTEXT, SPEC_DECODE, THEORY).
- LAZY_EXPERTS eq (3) rewritten as Q = max(1, 2d), d = \texttt{prefetch\_depth},
  and the RAM-budget expression as B * 2^20 / p_page, B = \texttt{ram\_budget\_mb},
  to avoid \mathrm{...\_...} MathJax ambiguity.

Version string unchanged at 0.3.3: docs are not shipped in the wheel
(MANIFEST.in and setuptools packages.find exclude them), so the PyPI
0.3.3 release remains valid; only the GitHub v0.3.3 tag needs to
point at this fix.

Matplotlib-mathtext strings in docs/assets/arch/make_arch.py and the
generated SVG XML comments are unaffected (different renderer).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@FonaTech
FonaTech merged commit 2008e0a into main Nov 13, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant